Skip to content

Add array_fold builtin function #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 25, 2025
Merged

Add array_fold builtin function #145

merged 1 commit into from
Sep 25, 2025

Conversation

@m-kus
Copy link
Contributor

@m-kus m-kus commented Sep 22, 2025

This PR adds array_fold similar to list folding, but for arbitrary array length.
Also added relevant section to the book, and VSCode syntax.

@m-kus m-kus force-pushed the feat/array-fold-macro branch from fbf5615 to e95bd7d Compare September 22, 2025 22:59
@uncomputable
Copy link
Collaborator

uncomputable commented Sep 23, 2025

Macros are compile-time snippets that expand into efficient Simplicity code, provifing a clean simple interface.

You are describing a builtin function, not a macro. A SimplicityHL macro is a notation that expands to SimplicityHL code, not to Simplicity code. list_fold is defined for arbitrary list lengths and it is also a builtin function. (These functions support a kind of generics that normal SimplicityHL functions don't support, but that doesn't matter.)

At this point in time, I think it's not desirable to add macros to SimplicityHL. They make it harder to reason about the code. Let's refactor the PR to clarify that array_fold is a builtin function.

@m-kus m-kus force-pushed the feat/array-fold-macro branch from e95bd7d to 8c4fd1b Compare September 23, 2025 22:30
@m-kus m-kus changed the title Add array_fold macro Add array_fold builtin function Sep 23, 2025
uncomputable
uncomputable approved these changes Sep 24, 2025
View reviewed changes
Copy link
Collaborator

@uncomputable uncomputable left a comment •
edited by apoelstra
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 8c4fd1b Looks good to me, but canndrew or apoelstra should also review this

apoelstra
apoelstra approved these changes Sep 25, 2025
View reviewed changes
Copy link
Contributor

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 8c4fd1b; successfully ran local tests

@apoelstra apoelstra merged commit 7ec4063 into BlockstreamResearch:master Sep 25, 2025
9 checks passed
@m-kus m-kus deleted the feat/array-fold-macro branch September 26, 2025 09:32
@apoelstra apoelstra mentioned this pull request Oct 31, 2025
Merged
apoelstra added a commit to apoelstra/s-lang that referenced this pull request Oct 31, 2025
@apoelstra
move builtins from crate root to private module in compile
142e63c 
This module was introduced in BlockstreamResearch#145 as a public module. But actually it is
only ever used by the compiler, and it doesn't really make sense outside
the compile because of its use of `ProgNode`.

We may want to later make the builtins module be an extension trait of
Constructible or something, but as long as it depends on ProgNode it
should not be public (and it cannot be public, after the next commit).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@apoelstra apoelstra apoelstra approved these changes

@uncomputable uncomputable uncomputable approved these changes

@canndrew canndrew Awaiting requested review from canndrew

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@m-kus @uncomputable @apoelstra